<!---
  Licensed to the Apache Software Foundation (ASF) under one
  or more contributor license agreements.  See the NOTICE file
  distributed with this work for additional information
  regarding copyright ownership.  The ASF licenses this file
  to you under the Apache License, Version 2.0 (the
  "License"); you may not use this file except in compliance
  with the License.  You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

  Unless required by applicable law or agreed to in writing,
  software distributed under the License is distributed on an
  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  KIND, either express or implied.  See the License for the
  specific language governing permissions and limitations
  under the License.
-->

<html>
    <head>
        <meta charset="utf-8">
        <title>Apache Yetus</title>
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <meta name="description" content="">
        <meta name="author" content="">

        <link href="/assets/css/bootstrap.css" rel="stylesheet">
        <link href="/assets/css/bootstrap-theme.css" rel="stylesheet">
                    <link href="/assets/css/font-awesome.css" rel="stylesheet">

        <!-- JS -->
        <script type="text/javascript" src="/assets/js/jquery-2.1.4.min.js"></script>
        <script type="text/javascript" src="/assets/js/bootstrap.js"></script>
  </head>
    <body>
      <div class="navbar navbar-inverse navbar-static-top" role="navigation">
    <div class="container">
        <div class="navbar-header">
            <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>
            <a class="img-responsive pull-left" href="/">
                <img style="max-height: 40px; margin-top: 5px; margin-bottom: 5px;" src="/assets/img/yetus_logo.png" alt="Apache Yetus logo" />
            </a>
        </div>
        <div class="navbar-collapse collapse">
            <ul class="nav navbar-nav">
                <li><a href="/downloads/">Downloads</a>
                <li class="dropdown">
                    <a class="dropdown-toggle" data-toggle="dropdown" href="#">Documentation <span class="caret"></span></a>
                    <ul class="dropdown-menu" role="menu">
                      <li><a href="/documentation/0.1.0/">Docs for v0.1.0</a></li>
                      <li><a href="/documentation/0.2.0/">Docs for v0.2.0</a></li>
                      <li><a href="/documentation/0.2.1/">Docs for v0.2.1</a></li>
                      <li><a href="/documentation/0.3.0/">Docs for v0.3.0</a></li>
                      <li><a href="/documentation/in-progress/">In Progress Docs for Contributors</a>
                      </li>
                    </ul>
                </li>
                <li class="dropdown">
                    <a class="dropdown-toggle" data-toggle="dropdown" href="#">Get Involved <span class="caret"></span></a>
                    <ul class="dropdown-menu" role="menu" aria-labelledby="drop1">
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="/mailinglists"><i class="fa fa-commenting"></i> Mailing Lists</a>
                        </li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="http://issues.apache.org/jira/browse/YETUS"><i class="fa fa-bug"></i> JIRA (Bugs)</a>
                        </li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="https://git-wip-us.apache.org/repos/asf?s=yetus"><i class="fa fa-code"></i> Source (Apache)</a>
                        </li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="https://github.com/apache/yetus"><i class="fa fa-github-alt"></i> Source (GitHub)</a>
                        </li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="/contribute/"><i class="fa fa-code-fork"></i> Contributing</a>
                        </li>
                        <li role="presentation"><a role="menuitem" tabindex="-1" href="https://twitter.com/ApacheYetus"><i class="fa fa-twitter"></i> @ApacheYetus</a>
                        </li>
                    </ul>
                </li>
                <li>
                    <li class="dropdown">
                        <a class="dropdown-toggle" data-toggle="dropdown" href="#">Apache Software Foundation <b class="caret"></b></a>
                        <ul class="dropdown-menu" role="menu">
                            <li><a href="http://www.apache.org">Apache Homepage</a>
                            </li>
                            <li><a href="http://www.apache.org/licenses/">Apache License</a>
                            </li>
                            <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a>
                            </li>
                            <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a>
                            </li>
                            <li><a href="http://www.apache.org/security/">Security</a>
                            </li>
                        </ul>
                    </li>
                </li>
            </ul>
        </div>
        <!--/.nav-collapse -->
    </div>
</div>

      <div class="container">
        <!---
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-->

<ul>
<li>Public/Stable/Replaceable

<ul>
<li><a href="#add_bugsystem">add_bugsystem</a></li>
<li><a href="#add_build_tool">add_build_tool</a></li>
<li><a href="#add_test">add_test</a></li>
<li><a href="#add_test_format">add_test_format</a></li>
<li><a href="#add_test_type">add_test_type</a></li>
<li><a href="#delete_bugsystem">delete_bugsystem</a></li>
<li><a href="#delete_build_tool">delete_build_tool</a></li>
<li><a href="#delete_test">delete_test</a></li>
<li><a href="#delete_test_format">delete_test_format</a></li>
<li><a href="#delete_test_type">delete_test_type</a></li>
<li><a href="#personality_plugins">personality_plugins</a></li>
<li><a href="#verify_needed_test">verify_needed_test</a></li>
<li><a href="#verify_plugin_enabled">verify_plugin_enabled</a></li>
</ul></li>
<li>Public/Stable/Not Replaceable

<ul>
<li><a href="#common_defaults">common_defaults</a></li>
<li><a href="#patchfile_verify_zero">patchfile_verify_zero</a></li>
<li><a href="#yetus_abs">yetus_abs</a></li>
<li><a href="#yetus_add_entry">yetus_add_entry</a></li>
<li><a href="#yetus_debug">yetus_debug</a></li>
<li><a href="#yetus_delete_entry">yetus_delete_entry</a></li>
<li><a href="#yetus_error">yetus_error</a></li>
<li><a href="#yetus_run_and_redirect">yetus_run_and_redirect</a></li>
<li><a href="#yetus_verify_entry">yetus_verify_entry</a></li>
</ul></li>
<li>Public/Evolving/Not Replaceable

<ul>
<li><a href="#list_plugins">list_plugins</a></li>
<li><a href="#plugin_usage_output">plugin_usage_output</a></li>
<li><a href="#yetus_add_header">yetus_add_header</a></li>
<li><a href="#yetus_add_option">yetus_add_option</a></li>
<li><a href="#yetus_comma_to_array">yetus_comma_to_array</a></li>
<li><a href="#yetus_generic_columnprinter">yetus_generic_columnprinter</a></li>
</ul></li>
<li>None/None/Not Replaceable

<ul>
<li><a href="#docker_version">docker_version</a></li>
</ul></li>
</ul>

<hr>

<h2 id="public-stable-replaceable">Public/Stable/Replaceable</h2>

<h3 id="add_bugsystem"><code>add_bugsystem</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>add_bugsystem bugsystem
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Add the given bugsystem type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="add_build_tool"><code>add_build_tool</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>add_build_tool build tool
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Add the given build tool type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="add_test"><code>add_test</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>add_test test
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Add the given test type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="add_test_format"><code>add_test_format</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>add_test_format test format
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Add the given test format type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="add_test_type"><code>add_test_type</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>add_test_type plugin
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Add the given test type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="delete_bugsystem"><code>delete_bugsystem</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>delete_bugsystem bugsystem
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Remove the given bugsystem type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="delete_build_tool"><code>delete_build_tool</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>delete_build_tool build tool
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Remove the given build tool type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="delete_test"><code>delete_test</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>delete_test test
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Remove the given test type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="delete_test_format"><code>delete_test_format</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>delete_test_format test format
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Remove the given test format type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="delete_test_type"><code>delete_test_type</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>delete_test_type plugin
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Remove the given test type</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="personality_plugins"><code>personality_plugins</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>personality_plugins plug-in list string
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Personality-defined plug-in list</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="verify_needed_test"><code>verify_needed_test</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>verify_needed_test test
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Verify if a given test was requested</p>

<ul>
<li>Returns</li>
</ul>

<p>0 = yes</p>

<p>1 = no</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h3 id="verify_plugin_enabled"><code>verify_plugin_enabled</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>verify_plugin_enabled test
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Determine if a plugin was enabled by the user ENABLED_PLUGINS must be defined</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">Yes</td>
</tr>
</tbody></table>
<h2 id="public-stable-not-replaceable">Public/Stable/Not Replaceable</h2>

<h3 id="common_defaults"><code>common_defaults</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>common_defaults
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Setup the default global variables</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="patchfile_verify_zero"><code>patchfile_verify_zero</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>patchfile_verify_zero log filename
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>if patch-level zero, then verify we aren&rsquo;t just adding files</p>

<ul>
<li>Returns</li>
</ul>

<p>$?</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_abs"><code>yetus_abs</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_abs fsobj
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Given a filename or dir, return the absolute version of it</p>

<ul>
<li>Returns</li>
</ul>

<p>0 success</p>

<p>1 failure</p>

<p>stdout abspath</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_add_entry"><code>yetus_add_entry</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_add_entry
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Given variable $1 add $2 to it</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_debug"><code>yetus_debug</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_debug string
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Print a message to stderr if &ndash;debug is turned on</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_delete_entry"><code>yetus_delete_entry</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_delete_entry
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Given variable $1 delete $2 from it</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_error"><code>yetus_error</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_error string
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Print a message to stderr</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_run_and_redirect"><code>yetus_run_and_redirect</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_run_and_redirect filename command [..]
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>run the command, sending stdout and stderr to the given filename</p>

<ul>
<li>Returns</li>
</ul>

<p>$?</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_verify_entry"><code>yetus_verify_entry</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_verify_entry
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Given variable $1 determine if $2 is in it</p>

<ul>
<li>Returns</li>
</ul>

<p>0 = yes, 1 = no</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Stable</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h2 id="public-evolving-not-replaceable">Public/Evolving/Not Replaceable</h2>

<h3 id="list_plugins"><code>list_plugins</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>list_plugins
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>List all installed plug-ins, regardless of whether they have been enabled</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="plugin_usage_output"><code>plugin_usage_output</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>plugin_usage_output array
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Print the plugin&rsquo;s usage info</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_add_header"><code>yetus_add_header</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_add_header header
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Add a header to the usage output</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_add_option"><code>yetus_add_option</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_add_option subcommand subcommanddesc
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Add an option to the usage output</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_comma_to_array"><code>yetus_comma_to_array</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_comma_to_array arrayname string
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Convert a comma-delimited string to an array</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h3 id="yetus_generic_columnprinter"><code>yetus_generic_columnprinter</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>yetus_generic_columnprinter array
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>Print a screen-size aware two-column output</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">Public</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">Evolving</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
<h2 id="none-none-not-replaceable">None/None/Not Replaceable</h2>

<h3 id="docker_version"><code>docker_version</code></h3>

<ul>
<li>Synopsis</li>
</ul>
<pre class="highlight plaintext"><code>docker_version
</code></pre>

<ul>
<li>Description</li>
</ul>

<p>None</p>

<ul>
<li>Returns</li>
</ul>

<p>Nothing</p>
<table class='table table-bordered table-striped'><thead><tr>
<th style="text-align: left">Classification</th>
<th style="text-align: left">Level</th>
</tr>
</thead><tbody><tr>
<td style="text-align: left">Audience</td>
<td style="text-align: left">None</td>
</tr>
<tr>
<td style="text-align: left">Stability</td>
<td style="text-align: left">None</td>
</tr>
<tr>
<td style="text-align: left">Replaceable</td>
<td style="text-align: left">No</td>
</tr>
</tbody></table>
    </div>
      <div class="container">
    <hr>
    <footer class="footer">
        <div class="row-fluid">
            <div class="span12 text-left">
              <div class="span12">
                Copyright 2008-2016 <a href="http://www.apache.org/">Apache Software Foundation</a>. Licensed under the <a href="http://www.apache.org/licenses/">Apache License v2.0</a>. Apache Yetus and the Apache feather logo are trademarks of The Apache Software Foundation.
              </div>
            </div>

        </div>

    </footer>
</div>

  </body>
</html>
